/*  
 *  Copyright 2006 Paul Jack.
 *
 *  This file is part of the Dex compiler suite. 
 *  
 *  Dex is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the
 *  Free Software Foundation; either version 2 of the License, or (at your
 *  option) any later version.
 *  
 *  Dex is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 *  Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
package dex.compiler.model.definition;

import java.util.List;

import dex.compiler.model.base.Place;


/**
 * Utility class to aid construction of definitions.  
 * Since definitions have so many individual fields, passing
 * them all along constructors would become tedious.
 */
public class DefinitionParams {
	
	
	/**
	 * The lists of attributes for the definition.
	 */
	private List<String> attributes;
	
	
	/**
	 * The name for the definition.
	 */
	private String name;
	
	
	/**
	 * The comment for the definition.
	 */
	private String comment;
	
	
	/**
	 * The modifier for the definition.
	 */
	private Modifier modifier;
	
	
	/**
	 * The place the definition originated at.
	 */
	private Place place;


	/**
	 * Constructs a new DefinitionParams with null values for everything.
	 */
	public DefinitionParams() {
	}


	/**
	 * Returns the list of attributes for the definition.
	 * 
	 * @return  the attributes
	 */
	public List<String> getAttributes() {
		return attributes;
	}


	/**
	 * Sets the list of attributes for the definition.
	 * 
	 * @param attributes  the attributes to set
	 */
	public void setAttributes(List<String> attributes) {
		this.attributes = attributes;
	}


	/**
	 * Returns the comment for the definition.
	 * 
	 * @return  the comment
	 */
	public String getComment() {
		return comment;
	}


	/**
	 * Sets the comment for the definition.
	 * 
	 * @param comment   the comment to set
	 */
	public void setComment(String comment) {
		this.comment = comment;
	}


	/**
	 * Returns the modifier for the definition
	 * 
	 * @return  the modifier
	 */
	public Modifier getModifier() {
		return modifier;
	}


	/**
	 * Sets the modifier for the definition.
	 * 
	 * @param modifier   the modifier to set
	 */
	public void setModifier(Modifier modifier) {
		this.modifier = modifier;
	}


	/**
	 * Returns the name of the thing being defined.
	 * 
	 * @return  the name of the thing being defined
	 */
	public String getName() {
		return name;
	}


	/**
	 * Sets the name of the thing being defined.
	 * 
	 * @param name   the name to set
	 */
	public void setName(String name) {
		this.name = name;
	}


	/**
	 * Returns the place where the definition originated.
	 * 
	 * @return  the place
	 */
	public Place getPlace() {
		return place;
	}


	/**
	 * Sets the place where the definition originated.
	 * 
	 * @param place  the place to set
	 */
	public void setPlace(Place place) {
		this.place = place;
	}


}
